5
תגובות
הערות
פתח
questioner
,
האם יש מעין צורה מוסכמת לכתיבת הערות?
5 תשובות
ענה
iiddaannyy
ב
29 ליוני 2012
#
בוודאי.
phpdoc.
ענה
להערה של שורה אחת -
// inline comment
להערה של כמה שורות -
/* multiline
comment */
comment */
ענה
אני מציע לכתוב כמה שפחות (אם אפשר בכלל לא, לפחות לנסות)
כמה שפחות הערות!
ענה
לכתוב הערות חובה. אך צריך לכתוב הערות במקום. אם זה שורה אחת עם פעולה ברורה ומובנת בלי שום הערה, אז לא צריך הערה. אחרת - חובה. אם תיישם את ההצעה למעלה, הקוד שלך יהיה בלאגן אחד גדול. לא רק שאנשים אחרים לא יבינו מה כתבת, גם אתה תתבלבל בסופו של דבר.
ענה
iiddaannyy
ב
30 ליוני 2012
#
דוגמה להערות שכל מתכנת php יבין (מתכנת שמכיר את ההערות המוסכמות).
<?php
/**
* Represents a user.
*/
class user {
/**
* @var int
*/
public $id;
/**
* @var string
*/
public $username;
/**
* Represents a user.
* @param int $id user's id.
*/
public function __construct($id) {
$this->id = $id;
}
/**
* Creates a new user.
* @param string $username user's username.
* @param string $password user's password.
* @return mixed the created user on success or false on failure.
*/
public static function create($username, $password) {
$mysqli = new mysqli(...);
$username = $mysqli->real_escape_string($username);
$password = $mysqli->real_escape_string($password);
$mysqli->query("
INSERT INTO `users` (
`username`,`password`
)
VALUES (
'$username',SHA1('$password')
)
");
return $mysqli->insert_id ? new user($mysqli->insert_id) : false;
}
}
?>
/**
* Represents a user.
*/
class user {
/**
* @var int
*/
public $id;
/**
* @var string
*/
public $username;
/**
* Represents a user.
* @param int $id user's id.
*/
public function __construct($id) {
$this->id = $id;
}
/**
* Creates a new user.
* @param string $username user's username.
* @param string $password user's password.
* @return mixed the created user on success or false on failure.
*/
public static function create($username, $password) {
$mysqli = new mysqli(...);
$username = $mysqli->real_escape_string($username);
$password = $mysqli->real_escape_string($password);
$mysqli->query("
INSERT INTO `users` (
`username`,`password`
)
VALUES (
'$username',SHA1('$password')
)
");
return $mysqli->insert_id ? new user($mysqli->insert_id) : false;
}
}
?>
מה שמתחיל בשטרודל הוא תג. יש עוד הרבה תגים.